fix: readd lost custom errors #182

Nidhi091999 · 2025-01-20T16:33:51Z

Issue: #168

Summary by Sourcery

Add InputUriError and IPDistanceCalculationError exceptions, and add a TesUriError exception.

New Features:

Added InputUriError for signaling invalid input URIs.
Added IPDistanceCalculationError for when IP distance calculation fails.
Added TesUriError for when a TES URI cannot be parsed.

Summary by Sourcery

Reintroduce and define custom error classes for specific error scenarios in the exceptions module

New Features:

Added custom error classes for TES URI parsing
Added custom error classes for input URI parsing
Added custom error class for IP distance calculation failures

Bug Fixes:

Restored previously lost custom error exceptions

sourcery-ai · 2025-01-20T16:33:56Z

Reviewer's Guide

This pull request re-introduces three custom exception classes (InputUriError, IPDistanceCalculationError, TesUriError) by defining them in pro_tes/exceptions.py and registering them in the exceptions dictionary with associated messages and HTTP status codes.

Class diagram for new exception types

classDiagram
    ValueError <|-- InputUriError
    note for InputUriError "Added in this PR"
    ValueError <|-- IPDistanceCalculationError
    note for IPDistanceCalculationError "Added in this PR"
    ValueError <|-- TesUriError
    note for TesUriError "Added in this PR"

File-Level Changes

Change	Details	Files
Added custom exception classes and registered them.	Defined `TesUriError`, `InputUriError`, and `IPDistanceCalculationError` inheriting from `ValueError`. Added entries for the new exceptions in the `exceptions` dictionary, mapping them to error messages and HTTP status codes (400 or 500).	`pro_tes/exceptions.py`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @Nidhi091999 - I've reviewed your changes - here's some feedback:

Overall Comments:

Please fill out the PR description with details about the motivation for these new exceptions and reference any related issues.
The exceptions dictionary entries should maintain consistency - TesUriError and IPDistanceCalculationError are missing HTTP status codes while other entries have them.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

sourcery-ai · 2025-01-20T16:34:48Z

pro_tes/exceptions.py

@@ -94,4 +102,14 @@ class InvalidMiddleware(MiddlewareException):
        "message": "Middleware is invalid.",
        "code": "500",
    },


issue: Missing error code for TesUriError and IPDistanceCalculationError exceptions

Other exceptions in the dictionary include both 'message' and 'code' fields. Consider adding appropriate error codes to maintain consistency in error handling.

uniqueg · 2025-03-05T13:48:26Z

Let's get to this after the repo is fixed again (broken tests) and after #184 is merged :)

sourcery-ai

Hey @Nidhi091999 - I've reviewed your changes - here's some feedback:

Consider inheriting the new custom exceptions from a shared base exception class specific to this application for better error categorization.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

uniqueg

Thanks :) Just two very small points on sorting the exceptions.

In fact, next to sorting by error code, you can also sort the exceptions by name, to make it even more tidy and easier to maintain. You can do that in the dictionary (code first, then name, exception: Exception), and in the exception class definitions (name only).

uniqueg · 2025-05-20T16:40:46Z

pro_tes/exceptions.py

@@ -94,4 +106,16 @@ class InvalidMiddleware(MiddlewareException):
        "message": "Middleware is invalid.",
        "code": "500",
    },
+    InputUriError: {
+        "message": "Input URI cannot be parsed.",
+        "code": "400",


Please sort the exceptions in this dictionary by the error code, in increasing order. The only exception is the very first exception Exception - please leave there where it is.

uniqueg · 2025-05-20T16:41:16Z

pro_tes/exceptions.py

+    },
+    TesUriError: {
+        "message": "TES URI cannot be parsed",
+        "code": "400",


Again, please add it with the other 400 errors

uniqueg · 2025-05-20T18:16:55Z

@Nidhi091999: Actually, the tests run on this PR - so perhaps this fixes the integration test issue observed in #186? I propose that you merge this one, update #186 to include the changes in here - and then perhaps we are good? :)

sourcery-ai bot reviewed Jan 20, 2025

View reviewed changes

Added InputUriError and IPDistanceCalculationError

b6c2e6d

Nidhi091999 force-pushed the nidhi/issue-168 branch from 493e0f4 to b6c2e6d Compare February 22, 2025 12:50

uniqueg marked this pull request as draft May 2, 2025 13:37

uniqueg changed the title ~~Draft: Added InputUriError and IPDistanceCalculationError~~ fix: readd InputUriError and IPDistanceCalculationError May 2, 2025

Merge branch 'dev' into nidhi/issue-168

9cbd10f

uniqueg changed the title ~~fix: readd InputUriError and IPDistanceCalculationError~~ fix: readd lost custom errors May 2, 2025

fix lint issues

4d4f795

Nidhi091999 marked this pull request as ready for review May 5, 2025 08:30

sourcery-ai bot reviewed May 5, 2025

View reviewed changes

uniqueg requested changes May 20, 2025

View reviewed changes

Sort exceptions by code and name

a45e8d9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: readd lost custom errors #182

fix: readd lost custom errors #182

Uh oh!

Nidhi091999 commented Jan 20, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jan 20, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot Jan 20, 2025

Uh oh!

uniqueg commented Mar 5, 2025

Uh oh!

sourcery-ai bot left a comment

Uh oh!

uniqueg left a comment

Uh oh!

uniqueg May 20, 2025

Uh oh!

uniqueg May 20, 2025

Uh oh!

uniqueg commented May 20, 2025

Uh oh!

Uh oh!

fix: readd lost custom errors #182

Are you sure you want to change the base?

fix: readd lost custom errors #182

Uh oh!

Conversation

Nidhi091999 commented Jan 20, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class diagram for new exception types

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jan 20, 2025

Choose a reason for hiding this comment

Uh oh!

uniqueg commented Mar 5, 2025

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

uniqueg left a comment

Choose a reason for hiding this comment

Uh oh!

uniqueg May 20, 2025

Choose a reason for hiding this comment

Uh oh!

uniqueg May 20, 2025

Choose a reason for hiding this comment

Uh oh!

uniqueg commented May 20, 2025

Uh oh!

Uh oh!

Nidhi091999 commented Jan 20, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jan 20, 2025 •

edited

Loading